Migrate installer to Go by portainer-mike · Pull Request #139 · portainer/kubesolo

portainer-mike · 2026-04-21T04:01:09Z

KS-45: Go installer — replaces install.sh, kubesolo-service.sh, uninstall.sh

Rewrites the three bash installer scripts as a single compiled Go CLI binary (cmd/installer). Built with CGO_ENABLED=0 so one binary per architecture covers both glibc and musl systems, eliminating the libc split the bash scripts handle at runtime.

Supported targets

linux/amd64, linux/arm64, linux/arm (armhf), linux/riscv64

CLI

sudo installer [flags]               # install (default)
sudo installer install [flags]
sudo installer uninstall [--purge]
sudo installer service start|stop|restart|status|logs
sudo installer download [--version=] [--path=]
installer check
installer version

All flags have KUBESOLO_* environment variable equivalents.

What's new

cmd/installer/ — cobra CLI entry point. Six subcommands: install (default), uninstall, service, download, check, version. uninstall removes the service, binary, and optionally the data directory (--purge).

internal/installer/config/ — Config struct and constants. CmdArgs() builds the argument list passed to the kubesolo binary using bare boolean flags (--debug not --debug=true) to match kubesolo's flag parser.

internal/installer/detect/ — host detection with no subprocess calls. Detects arch, libc (musl vs glibc via /lib/ld-musl-*.so.1), init system (from filesystem landmarks — no which/command -v), and environment (container, SBC).

internal/installer/preflight/ — seven ordered checks: root, hostname RFC 1123, Docker conflict, iptables xt_comment module, nftables+iptables (Alpine only, installs via apk add if --install-prereqs), cgroups (enables Alpine OpenRC cgroups service proactively if needed), required ports. Stop runs before preflight so ports held by an existing KubeSolo installation don't cause false failures.

internal/installer/process/ — stops running KubeSolo before reinstalling. Reads /proc/*/exe symlinks, SIGTERMs with exponential backoff, SIGKILLs stragglers. Port holders found via /proc/net/tcp[6] inode mapping. No dependency on lsof, ss, or netstat.

internal/installer/download/ — online and offline install. Extracts by base name so nested tar paths (kubesolo-v1.1.2-linux-amd64/kubesolo) are handled correctly. Atomic install via os.Rename; cross-device fallback (tmpfs → ext4 on Alpine) explicitly chmod 0755es the staged binary before the final rename.

internal/installer/service/ — seven init system backends behind a common Manager interface: systemd, OpenRC, SysV, s6, runit, upstart, daemon (fallback). All templates support optional proxy environment injection. daemon_linux.go / daemon_other.go split via build tags keeps the package compilable on macOS for local development.

internal/installer/kubeconfig/ — waits up to 30s for the admin kubeconfig to appear, then merges it into the real user's ~/.kube/config via kubectl config view --flatten. Real user resolved in order: SUDO_USER (sudo), DOAS_USER (doas), /proc/self/loginuid (kernel login UID, preserved across any privilege escalation — reliable catch-all for doas on Alpine), fallback to current user. Source kubeconfig is chowned to the real user so KUBECONFIG=<path> in shell profiles keeps working.

scripts/get.sh — bootstrap script for get.kubesolo.io. Detects arch via uname -m, downloads the correct installer-linux-<arch> binary, and execs it. Supports KUBESOLO_VERSION, KUBESOLO_INSTALLER_BASE_URL, and KUBESOLO_FLAT_URLS for version pinning and internal mirrors.

Makefile — adds build-installer, build-installer-all, test-installer, clean-installer targets.

Building

make build-installer-all        # all four architectures → dist/
make test-installer              # unit tests (no root, no Linux required)

linear · 2026-04-21T04:01:13Z

KS-45 Consider migrating install script to Go-based CLI tool

Copilot

Pull request overview

This PR migrates the KubeSolo installer from multiple bash scripts to a single compiled Go-based CLI (cmd/installer) with subcommands for install/uninstall/service/download/check/version.

Changes:

Added a new Go installer CLI (cobra) that performs host detection, preflight checks, binary download/offline install, service setup, and kubeconfig merge.
Implemented init-system service backends (systemd/OpenRC/SysV/s6/runit/upstart) plus daemon/foreground run modes.
Added bootstrap script (scripts/get.sh) and Makefile targets to build/test the installer across supported architectures.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
scripts/get.sh	Adds a curl/wget bootstrap script that downloads and execs the correct installer binary per arch.
cmd/installer/main.go	Introduces the main cobra CLI and wires install/uninstall/service/download/check/version flows.
internal/installer/config/config.go	Defines installer configuration defaults and builds kubesolo CLI args.
internal/installer/config/config_test.go	Unit tests for `Config.CmdArgs()`.
internal/installer/detect/detect.go	Filesystem-/proc-based detection for arch/libc/init/environment and archive naming.
internal/installer/detect/detect_test.go	Unit tests for archive naming, arch mapping, and constants.
internal/installer/download/download.go	Downloads/extracts KubeSolo archives and supports offline installation.
internal/installer/download/download_test.go	Unit tests for tar.gz extraction, copy, and progress reader.
internal/installer/kubeconfig/kubeconfig.go	Waits for admin kubeconfig then merges it into the invoking user’s kubeconfig.
internal/installer/preflight/preflight.go	Implements ordered preflight checks (root/hostname/docker/iptables/alpine/cgroups/ports).
internal/installer/preflight/preflight_test.go	Tests for hostname regex, controllers, suite, and best-effort env checks.
internal/installer/process/process.go	Stops existing KubeSolo processes via /proc scanning and port-owner detection.
internal/installer/process/exec.go	Wraps command creation for potential test substitution.
internal/installer/process/process_test.go	Unit tests for PID parsing, min duration, ports list, and non-panicking inode parsing.
internal/installer/service/manager.go	Defines `Manager` interface, routing by init system/run mode, and template helpers.
internal/installer/service/systemd.go	systemd unit generation/install/uninstall and systemctl invocations.
internal/installer/service/openrc.go	OpenRC init script generation/install/uninstall.
internal/installer/service/sysvinit.go	SysV init script generation/install/uninstall plus enable/start logic.
internal/installer/service/s6.go	s6 service directory/scripts generation and optional supervisor activation.
internal/installer/service/runit.go	runit service directory/script generation and enabling via symlink.
internal/installer/service/upstart.go	Upstart job generation/install/uninstall via initctl.
internal/installer/service/daemon.go	Fallback daemon-mode runner that starts kubesolo detached and writes a PID file.
internal/installer/service/daemon_linux.go	Linux-specific `SysProcAttr` for daemon detachment.
internal/installer/service/daemon_other.go	Non-Linux stub to keep builds/tests working on dev machines.
internal/installer/service/foreground.go	Foreground run mode that executes kubesolo attached to the current TTY.
internal/installer/service/service_test.go	Template rendering tests and init-system routing tests for `New()`.
Makefile	Adds build/test/clean targets for the new installer binary across architectures.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 8 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Restructure the Go installer into a multi-command CLI tool following the Cilium CLI pattern. Thin cmd/kubesoloctl/main.go entry point delegates to internal/cli package which owns the full cobra command tree. Commands: install, uninstall, upgrade, download, check, kubeconfig, reset, completion, version. Running without a subcommand defaults to install for backward compatibility. - Rename cmd/installer → cmd/kubesoloctl - Rename internal/installer → internal/cli - Split monolithic main.go into per-command files - Add Makefile targets: build-kubesoloctl, test-kubesoloctl - Update scripts/get.sh and CI workflow for new binary name - Bump default version to v1.1.5

Copilot

Pull request overview

Copilot reviewed 40 out of 42 changed files in this pull request and generated 7 comments.

+			info, err := detect.Detect()
+			if err != nil {
+				return err
+			}
+			mgr, err := service.New(info, config.RunModeService)
+			if err != nil {
+				return err
+			}
+
+			if err := mgr.Uninstall(); err != nil {
+				return err
+			}


+	case detect.InitOpenRC, detect.InitSysV:
+		return runCmd("tail", "-f", "/var/log/messages")


+func checkCmd(cfg *config.Config) *cobra.Command {
+	return &cobra.Command{
+		Use:   "check",
+		Short: "Run pre-flight checks without installing",
+		Long:  `Validates that this host meets all requirements for KubeSolo. Exits 0 on success.`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			info, err := detect.Detect()
+			if err != nil {
+				return err
+			}
+			log.Info().
+				Str("arch", info.Arch).
+				Str("libc", string(info.LibC)).
+				Str("init", string(info.InitSystem)).
+				Str("env", string(info.Environment)).
+				Msg("host detected")
+			return preflight.RunSuite(preflight.Suite(cfg.InstallPrereqs, cfg.PprofServer))
+		},


+	log.Info().Msg("starting KubeSolo service (fresh cluster)...")
+	if _, err := service.New(info, config.RunModeService); err != nil {
+		log.Info().Msg("reset complete — start KubeSolo manually to initialize a fresh cluster")
+		return nil
+	}


+# Supported targets: linux/amd64, linux/arm64, linux/arm (armhf), linux/riscv64
+
+KUBESOLOCTL_LDFLAGS = -s -w \
+	-X main.Version=$(VERSION) \
+	-X main.Commit=$(COMMIT) \
+	-X main.BuildDate=$(BUILD_DATE)
+
+KUBESOLOCTL_OUTPUT ?= ./dist/kubesoloctl-$(GOOS)-$(GOARCH)
+
+# Build kubesoloctl for the current GOOS/GOARCH.
+# Pass GOARM=7 when targeting arm (armhf/ARMv7), e.g.: make build-kubesoloctl GOARCH=arm GOARM=7
+.PHONY: build-kubesoloctl
+build-kubesoloctl:
+	@mkdir -p $(dir $(KUBESOLOCTL_OUTPUT))
+	CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH) GOARM=$(GOARM) go build \
+		-ldflags="$(KUBESOLOCTL_LDFLAGS)" \
+		-o $(KUBESOLOCTL_OUTPUT) \
+		./cmd/kubesoloctl
+
+# Build kubesoloctl for all supported architectures
+.PHONY: build-kubesoloctl-all
+build-kubesoloctl-all:
+	GOARCH=amd64   KUBESOLOCTL_OUTPUT=./dist/kubesoloctl-linux-amd64   make build-kubesoloctl
+	GOARCH=arm64   KUBESOLOCTL_OUTPUT=./dist/kubesoloctl-linux-arm64   make build-kubesoloctl
+


+    name: build kubesoloctl-linux-${{ matrix.goarch }}
+    runs-on: ubuntu-latest
+    needs: [test]
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - goarch: amd64
+        - goarch: arm64
+    steps:


+# detect architecture
+ARCH=$(uname -m)
+case "$ARCH" in
+  x86_64)              ARCH=amd64   ;;
+  aarch64)             ARCH=arm64   ;;
+  *)
+    printf 'error: unsupported architecture: %s\n' "$ARCH" >&2
+    printf 'supported: x86_64 (amd64), aarch64 (arm64)\n' >&2
+    exit 1
+    ;;


portainer-mike added 2 commits April 21, 2026 15:55

Initial Go migration

feb1f8e

adding remaining files

132c1c7

portainer-mike requested a review from Copilot April 21, 2026 04:01

Merge branch 'develop' into KS-45

1d712d8

Copilot started reviewing on behalf of portainer-mike April 21, 2026 04:02 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

tackling some of the copilot concerns

5fe47e5

portainer-mike requested a review from Copilot April 21, 2026 08:13

Copilot started reviewing on behalf of portainer-mike April 21, 2026 08:13 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

resolving a few more concerns, adding --arch flag to download

ec87702

portainer-mike requested a review from Copilot April 21, 2026 23:05

Copilot started reviewing on behalf of portainer-mike April 21, 2026 23:06 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

portainer-mike and others added 3 commits April 22, 2026 13:16

resolve further copilot concerns

9435c20

adding release action for installer

bd8279e

stevensbkang requested a review from Copilot May 13, 2026 08:05

Copilot started reviewing on behalf of stevensbkang May 13, 2026 08:06 View session

Copilot AI reviewed May 13, 2026

View reviewed changes

		case detect.InitOpenRC, detect.InitSysV:
		return runCmd("tail", "-f", "/var/log/messages")

Conversation

portainer-mike commented Apr 21, 2026

KS-45: Go installer — replaces install.sh, kubesolo-service.sh, uninstall.sh

Supported targets

CLI

What's new

Building

Uh oh!

linear Bot commented Apr 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants